Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ENH: command line interface #72

Merged
merged 1 commit into from
Jan 30, 2024
Merged

ENH: command line interface #72

merged 1 commit into from
Jan 30, 2024

Conversation

ntessore
Copy link
Contributor

@ntessore ntessore commented Dec 4, 2023

Implementation of the Heracles command line interface (CLI). The CLI is meant to make it quick and easy to perform a "standard" analysis of catalogues, that is: obtaining angular power spectra, mixing matrices, and eventually jackknife covariances.

The CLI uses a configuration file (default file name heracles.cfg), of which an example is provided in the examples/ folder.

The analysis itself uses a series of commands that build up e.g. angular power spectra:

heracles alms myalms.fits
heracles spectra myspectra.fits myalms.fits
heracles mixmats mymixmats.fits myalms.fits

The following commands are currently implemented:

  • maps -- create HEALPix maps from catalogues
  • alms -- compute spherical harmonic coefficients (alms); either from catalogues or pre-computed maps
  • spectra -- compute angular power spectra from alms
  • mixmats -- compute mixing matrices

There is help available for every command (heracles <cmd> -h).

Closes: #56

@ntessore ntessore marked this pull request as ready for review January 30, 2024 09:55
@ntessore ntessore merged commit 58c882c into main Jan 30, 2024
6 checks passed
@ntessore ntessore deleted the gh-56 branch January 30, 2024 10:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Command line interface
1 participant